Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: context menu on custom reports page #3776

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

UnderKoen
Copy link
Member

No description provided.

@actual-github-bot actual-github-bot bot changed the title enhance: context menu on custom reports page [WIP] enhance: context menu on custom reports page Nov 3, 2024
Copy link

netlify bot commented Nov 3, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 9a21ace
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67574ccceab95900074a80d7
😎 Deploy Preview https://deploy-preview-3776.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

github-actions bot commented Nov 3, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
10 5.45 MB → 5.45 MB (+539 B) +0.01%
Changeset
File Δ Size
src/components/reports/ReportCard.tsx 📈 +539 B (+15.98%) 3.29 kB → 3.82 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/ReportRouter.js 1.52 MB → 1.52 MB (+539 B) +0.03%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.96 kB 0%
static/js/wide.js 241.09 kB 0%
static/js/index.js 3.44 MB 0%

Copy link
Contributor

github-actions bot commented Nov 3, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.32 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.32 MB 0%

@UnderKoen UnderKoen changed the title [WIP] enhance: context menu on custom reports page enhance: context menu on custom reports page Nov 3, 2024
Copy link
Contributor

coderabbitai bot commented Nov 3, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/src/components/reports/ReportCard.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request modifies the ReportCard component in ReportCard.tsx by integrating a new context menu functionality through the useContextMenu hook. This change centralizes the management of the context menu state, replacing the previous local state management. The Layout function now utilizes several state and handler functions provided by useContextMenu, including setMenuOpen, menuOpen, handleContextMenu, and resetPosition. An onContextMenu event handler is added to the View component to invoke handleContextMenu. Additionally, the rendering logic for the MenuButton is updated to call resetPosition before setting menuOpen to true. The Popover component's triggerRef is conditionally assigned based on the context menu's active state, and the isOpen prop is explicitly converted to a boolean. Overall, these changes enhance the component's functionality by improving context menu handling.

Possibly related PRs

  • enhance: context menu budget page positioning #3775: This PR enhances context menu positioning and integrates the useContextMenu hook, which is directly related to the changes made in the main PR that also implements useContextMenu for managing context menus in the ReportCard component.

Suggested labels

:sparkles: Merged

Suggested reviewers

  • youngcw
  • matt-fidd

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1c13cd0 and 9a21ace.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/reports/ReportCard.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/desktop-client/src/components/reports/ReportCard.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e078ed2 and 2df910e.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3776.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/reports/ReportCard.tsx (3 hunks)
🔇 Additional comments (6)
packages/desktop-client/src/components/reports/ReportCard.tsx (6)

11-11: Importing useFeatureFlag is correctly added

The import statement is necessary for the feature flag usage in the component.


129-134: State variables initialized for context menu functionality

The addition of viewRef, menuOpen, crossOffset, offset, and contextMenusEnabled sets up the necessary state and references for managing the context menu.


135-135: isContextMenu derived state implemented correctly

The isContextMenu variable accurately determines when the context menu is active.


139-147: Context menu event handler correctly implemented

The onContextMenu handler appropriately activates the context menu when the feature flag is enabled and calculates the positioning offsets based on the mouse event.


176-181: Resetting offsets and updating menu state on button press

The MenuButton correctly resets crossOffset and offset and updates menuOpen to 'button' when pressed.


187-193: Popover component configured appropriately for different menu triggers

The Popover component uses the correct triggerRef, placement, and offsets based on whether the context menu or button menu is active.

@youngcw
Copy link
Member

youngcw commented Nov 11, 2024

This will probably need gated by the reports dashboard feature flag since it is using the dashboard features in the menu.

…_menus/reports_page

# Conflicts:
#	packages/desktop-client/src/components/reports/ReportCard.tsx
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
packages/desktop-client/src/components/reports/ReportCard.tsx (1)

171-179: Reconsider offset reset in MenuButton handler.

The MenuButton handler resets both offsets to 0, which might cause the menu to appear in an unexpected position when toggling between context menu and button menu states. Consider preserving the last known good position or calculating appropriate offsets based on the button's position.

 <MenuButton
   ref={triggerRef}
   onPress={() => {
-    setCrossOffset(0);
-    setOffset(0);
+    const rect = triggerRef.current?.getBoundingClientRect();
+    if (rect) {
+      setCrossOffset(rect.width);
+      setOffset(0);
+    }
     setMenuOpen('button');
   }}
 />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2df910e and 41d9b14.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/reports/ReportCard.tsx (3 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/desktop-client/src/components/reports/ReportCard.tsx (1)
Learnt from: UnderKoen
PR: actualbudget/actual#3776
File: packages/desktop-client/src/components/reports/ReportCard.tsx:165-167
Timestamp: 2024-11-10T16:45:31.225Z
Learning: In `ReportCard.tsx`, the usage of `className=[menuOpen ? undefined : 'hover-visible', NON_DRAGGABLE_AREA_CLASS_NAME].join(' ')` in the `Layout` function is intentional and does not cause styling issues in the codebase.
🔇 Additional comments (1)
packages/desktop-client/src/components/reports/ReportCard.tsx (1)

123-126: LGTM! Well-structured state management.

The state management is well-implemented with:

  • Proper TypeScript union type for menu states
  • Clear separation of positioning states
  • Appropriate use of refs for DOM references

@matt-fidd matt-fidd self-assigned this Nov 19, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
packages/desktop-client/src/components/reports/ReportCard.tsx (1)

136-143: Consider enhancing menu positioning robustness

While the core implementation is solid, consider adding viewport boundary checks to ensure the menu stays within visible bounds.

 onContextMenu={e => {
   if (!contextMenusEnabled) return;
   e.preventDefault();
   setMenuOpen('context');
   const rect = e.currentTarget.getBoundingClientRect();
-  setCrossOffset(e.clientX - rect.left);
-  setOffset(e.clientY - rect.bottom);
+  const viewportWidth = window.innerWidth;
+  const viewportHeight = window.innerHeight;
+  const newCrossOffset = Math.min(
+    e.clientX - rect.left,
+    viewportWidth - rect.width
+  );
+  const newOffset = Math.min(
+    e.clientY - rect.bottom,
+    viewportHeight - rect.height
+  );
+  setCrossOffset(newCrossOffset);
+  setOffset(newOffset);
 }}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 41d9b14 and 1c13cd0.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3776.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/reports/ReportCard.tsx (3 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/desktop-client/src/components/reports/ReportCard.tsx (1)
Learnt from: UnderKoen
PR: actualbudget/actual#3776
File: packages/desktop-client/src/components/reports/ReportCard.tsx:165-167
Timestamp: 2024-11-10T16:45:31.225Z
Learning: In `ReportCard.tsx`, the usage of `className=[menuOpen ? undefined : 'hover-visible', NON_DRAGGABLE_AREA_CLASS_NAME].join(' ')` in the `Layout` function is intentional and does not cause styling issues in the codebase.
🪛 GitHub Check: typecheck
packages/desktop-client/src/components/reports/ReportCard.tsx

[failure] 127-127:
Argument of type '"dashboards"' is not assignable to parameter of type 'FeatureFlag'.

🔇 Additional comments (2)
packages/desktop-client/src/components/reports/ReportCard.tsx (2)

123-126: Well-structured state management for menu positioning

The state management is well-implemented with proper typing and clear separation of concerns between menu state and positioning.


171-189: Clean implementation of menu button and popover integration

The integration handles state transitions properly and uses appropriate refs based on the context. The positioning logic is well-thought-out.

@matt-fidd
Copy link
Contributor

This will need altering a bit now that dashboards are released, there's no need for the feature flag anymore

@matt-fidd
Copy link
Contributor

I've found a bug:

  1. Right click report
  2. Rename
  3. Click inside the name input box (as if you were placing the cursor)
  4. The report opens instead of placing the cursor

@youngcw youngcw added this to the v25.1.0 milestone Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants